openapi: 3.0.0 info: title: Slope API description: The Slope REST API version: v3 contact: {} x-konfig-ignore: object-with-no-properties: true servers: - description: Sandbox environment url: https://api.sandbox.slope.so - description: Production environment url: https://api.slope.so tags: - name: Orders - name: Invoices - name: Payout Accounts - name: Customers - name: Merchants paths: /v3/merchants: get: tags: - Merchants summary: Get merchant operationId: Merchants_getSettings security: - apiKeys: [] description: Gets settings about your merchant. parameters: - description: The nested objects to expand as part of the response. name: expand required: false in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/MerchantsGetSettingsResponse' /v3/orders: post: tags: - Orders summary: Create an order operationId: Orders_createNewOrder security: - apiKeys: [] description: Creates a new order. parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrdersCreateNewOrderRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersCreateNewOrderResponse' get: tags: - Orders summary: List orders operationId: Orders_listOrders security: - apiKeys: [] description: >- Lists all orders using pagination. An optional `filter` parameter may be set to list a specific subset of orders. parameters: - description: The maximum number of objects to list. name: limit required: false in: query schema: minimum: 0 maximum: 50 - description: The object attribute(s) to sort by. name: orderBy required: false in: query schema: type: array items: type: string enum: - id - createdAt - externalId - total - description: The direction to sort by, one of `asc` or `desc`. name: order required: false in: query schema: enum: - asc - desc type: string - description: The cursor used to fetch the previous page of objects. name: beforeCursor required: false in: query schema: type: string - description: The cursor used to fetch the next page of objects. name: afterCursor required: false in: query schema: type: string - name: filter required: false in: query style: deepObject explode: true schema: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: {} required: - operator required: - operator required: - operator required: - operator - description: The nested objects to expand as part of the response. name: expand required: false in: query schema: type: array items: type: string responses: '200': description: The paginated list of orders. content: application/json: schema: $ref: '#/components/schemas/OrdersListOrdersResponse' /v3/orders/{id}: get: tags: - Orders summary: Get an order operationId: Orders_getById security: - orderIntent: [] - apiKeys: [] description: Gets an order by ID. parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersGetByIdResponse' post: tags: - Orders summary: Update an order operationId: Orders_updateAttributes security: - orderIntent: [] - apiKeys: [] description: Updates attributes of an order. A finalized order cannot be updated. parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrdersUpdateAttributesRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersUpdateAttributesResponse' /v3/orders/{id}/intent: post: tags: - Orders summary: Generate an order intent operationId: Orders_generateIntentSecret security: - apiKeys: [] description: >- Generates an order intent secret that may be used to open the Slope widget. parameters: - name: id required: true in: path schema: type: string - name: timeoutMs required: true in: query schema: type: string responses: '201': description: '' /v3/orders/{id}/submit: post: tags: - Orders summary: Submit an order operationId: Orders_submitOrderStatus security: - apiKeys: [] description: Attempts to move an order to the Submitted status. parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrdersSubmitOrderStatusRequest' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersSubmitOrderStatusResponse' /v3/orders/{id}/open: post: tags: - Orders summary: Open an order operationId: Orders_openOrder security: - apiKeys: [] description: Attempts to move an order to the Open status. parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrdersOpenOrderRequest' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersOpenOrderResponse' /v3/orders/{id}/finalize: post: tags: - Orders summary: Finalize an order operationId: Orders_finalizeOrder security: - apiKeys: [] description: Attempts to move an order to the Finalized status. parameters: - name: id required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersFinalizeOrderResponse' /v3/orders/{id}/cancel: post: tags: - Orders summary: Cancel an order operationId: Orders_cancelOrder security: - apiKeys: [] description: Cancels an order. A finalized order cannot be canceled. parameters: - name: id required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersCancelOrderResponse' /v3/orders/{id}/refund: post: tags: - Orders summary: Refund an order operationId: Orders_refundOrder security: - apiKeys: [] description: 'Refund an order. ' parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrdersRefundOrderRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersRefundOrderResponse' /v3/orders/{id}/reset: post: tags: - Orders summary: Reset an order operationId: Orders_resetOrder security: - apiKeys: [] description: >- Resets an order. New offers are generated and any customer inputs such as payment method or payment terms are reset. parameters: - name: id required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/OrdersResetOrderResponse' /v3/payout-accounts: post: tags: - Payout Accounts summary: Create a payout account operationId: PayoutAccounts_createWithExternalId description: Create a payout account with externalId parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayoutAccountsCreateWithExternalIdRequest' responses: '201': description: '' content: application/json: schema: $ref: >- #/components/schemas/PayoutAccountsCreateWithExternalIdResponse get: tags: - Payout Accounts summary: List all payout accounts operationId: PayoutAccounts_listAllPayoutAccounts description: List all payout accounts parameters: [] responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/PayoutAccountsListAllPayoutAccountsResponse /v3/payout-accounts/{id}: patch: tags: - Payout Accounts summary: Update a payout account operationId: PayoutAccounts_updateWithExternalId description: Update a payout account with externalId parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayoutAccountsUpdateWithExternalIdRequest' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/PayoutAccountsUpdateWithExternalIdResponse get: tags: - Payout Accounts summary: Get a payout account operationId: PayoutAccounts_getById description: Get a payout account with id or externalId parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PayoutAccountsGetByIdResponse' delete: tags: - Payout Accounts summary: Delete a payout account operationId: PayoutAccounts_deleteAccount description: Delete a payout account with an id parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' /v3/invoices: get: tags: - Invoices summary: List invoices operationId: Invoices_list security: - apiKeys: [] description: >- Lists all invoices using pagination. An optional `filter` parameter may be set to list a specific subset of invoices. parameters: - description: The maximum number of objects to list. name: limit required: false in: query schema: minimum: 0 maximum: 50 - description: The object attribute(s) to sort by. name: orderBy required: false in: query schema: type: array items: type: string enum: - id - createdAt - description: The direction to sort by, one of `asc` or `desc`. name: order required: false in: query schema: enum: - asc - desc type: string - description: The cursor used to fetch the previous page of objects. name: beforeCursor required: false in: query schema: type: string - description: The cursor used to fetch the next page of objects. name: afterCursor required: false in: query schema: type: string - name: filter required: false in: query style: deepObject explode: true schema: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: {} required: - operator required: - operator required: - operator required: - operator - description: The nested objects to expand as part of the response. name: expand required: false in: query schema: type: array items: type: string responses: '200': description: The paginated list of invoices. content: application/json: schema: $ref: '#/components/schemas/InvoicesListResponse' post: tags: - Invoices summary: Create an invoice operationId: Invoices_createNewInvoice security: - apiKeys: [] description: Creates a new invoice, which can be in the draft or open status. parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InvoicesCreateNewInvoiceRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/InvoicesCreateNewInvoiceResponse' /v3/invoices/{id}: get: tags: - Invoices summary: Get an invoice operationId: Invoices_getById security: - orderIntent: [] - apiKeys: [] description: Gets an invoice by ID. parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InvoicesGetByIdResponse' /v3/invoices/{id}/open: post: tags: - Invoices summary: Open an invoice operationId: Invoices_openDraft security: - apiKeys: [] description: Opens a draft invoice. parameters: - name: id required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/InvoicesOpenDraftResponse' /v3/invoices/{id}/void: post: tags: - Invoices summary: Void an invoice operationId: Invoices_voidInvoice security: - apiKeys: [] description: >- Voids an invoice and cancels any scheduled payments for associated orders. parameters: - name: id required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/InvoicesVoidInvoiceResponse' /v3/invoices/{id}/cancel: post: tags: - Invoices summary: Cancel an invoice operationId: Invoices_cancelInvoice security: - apiKeys: [] description: >- Cancels an invoice that is either in the draft state or has not created any orders or payments yet. Generally, an invoice should be voided rather than outright canceled. parameters: - name: id required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/InvoicesCancelInvoiceResponse' /v3/customers: post: tags: - Customers summary: Create a customer operationId: Customers_registerNewCustomer security: - apiKeys: [] description: Creates a new customer. parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomersRegisterNewCustomerRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CustomersRegisterNewCustomerResponse' get: tags: - Customers summary: List customers operationId: Customers_listAll security: - apiKeys: [] description: >- Lists all customers using pagination. An optional `filter` parameter may be set to list a specific subset of customers parameters: - description: The maximum number of objects to list. name: limit required: false in: query schema: minimum: 0 maximum: 50 - description: The object attribute(s) to sort by. name: orderBy required: false in: query schema: type: array items: type: string enum: - id - createdAt - description: The direction to sort by, one of `asc` or `desc`. name: order required: false in: query schema: enum: - asc - desc type: string - description: The cursor used to fetch the previous page of objects. name: beforeCursor required: false in: query schema: type: string - description: The cursor used to fetch the next page of objects. name: afterCursor required: false in: query schema: type: string - name: filter required: false in: query style: deepObject explode: true examples: eligibleCustomers: summary: Eligible customers description: A filter to list only customers that are eligible. value: attribute: eligible operator: equals value: true ineligibleCustomers: summary: Ineligible customers description: A filter to list only customers that are ineligible. value: attribute: eligible operator: equals value: false ineligibleCustomersWithTaxIds: summary: Ineligible customers with a tax ID description: A filter to list only ineligible customers that have a tax ID. value: operator: and conditions: - attribute: eligible operator: equals value: false - attribute: kyb.taxId operator: not-equals value: null schema: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: {} required: - operator required: - operator required: - operator required: - operator - description: The nested objects to expand as part of the response. name: expand required: false in: query schema: type: array items: type: string responses: '200': description: The paginated list of customers. content: application/json: schema: $ref: '#/components/schemas/CustomersListAllResponse' /v3/customers/{id}: get: tags: - Customers summary: Get a customer operationId: Customers_getById security: - orderIntent: [] - apiKeys: [] description: Get a specific customer by ID or external ID. parameters: - description: >- The customer ID assigned by Slope _or_ the customer external ID assigned by you. name: id required: true in: path schema: type: string - description: The nested objects to expand as part of the response. name: expand required: false in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CustomersGetByIdResponse' post: tags: - Customers summary: Update a customer operationId: Customers_updateExistingCustomer security: - orderIntent: [] - apiKeys: [] description: Updates an existing customer. parameters: - description: >- The customer ID assigned by Slope _or_ the customer external ID assigned by you. name: id required: true in: path schema: type: string - description: The nested objects to expand as part of the response. name: expand required: false in: query schema: type: array items: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomersUpdateExistingCustomerRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CustomersUpdateExistingCustomerResponse' /v3/customers/{id}/intent: post: tags: - Customers summary: Generate an customer intent operationId: Customers_generateIntentSecret security: - apiKeys: [] description: >- Generates an customer intent secret that may be used by the Slope widget or buyer portal. parameters: - name: id required: true in: path schema: type: string responses: '201': description: '' components: securitySchemes: apiKeys: type: http scheme: basic orderIntent: type: http scheme: bearer schemas: AddressEntity: type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode IneligibilityReason: type: object properties: code: description: |- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: |- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message UBO: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address CreditReportMonetary: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency CreditReport: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency balance: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw KYB: type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency balance: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw SocialMediaUrls: type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string ExternalPurchaseReason: type: object properties: code: description: |- A short string describing why the external purchase has its given status. type: string message: description: |- A human-friendly message explaining why the external purchase has its given status. type: string ExternalPurchaseItemEntity: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: |- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt ExternalPurchaseEntity: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: |- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer that which the external purchase belongs. type: string customer: description: |- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: {} required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: {} required: - amount - currency balance: type: object properties: {} required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - {} sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: |- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: |- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: |- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - {} sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: |- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt PayoutEntity: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: |- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ACHData: type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash CardData: type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType PaymentMethodEntity: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: |- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: {} required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: {} required: - amount - currency balance: type: object properties: {} required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - {} sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt InvoiceItemEntity: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: >- The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: >- The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt InvoiceEventEntity: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: >- The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt InvoiceMilestoneEntity: type: object properties: description: description: Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: >- The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: >- The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt InvoiceEntity: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: {} required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: {} required: - amount - currency balance: type: object properties: {} required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - {} sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: |- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt CustomerEntity: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency balance: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt PaymentTermsEntity: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt OrderItemEntity: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: >- The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: >- The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt OrderVendor: type: object properties: id: type: string name: type: string category: type: string required: - id - name - category OrderPaymentScheduleStatusView: type: object properties: {} LedgerAccountEntity: type: object properties: createdAt: description: The time at which the object was created. format: date-time type: string id: type: string currency: type: string enum: - mxn - usd accountingType: type: string enum: - asset - liability - revenue accountingSubtype: type: string enum: - cash - accounts_receivable - accounts_payable - interest type: type: string enum: - stripe - merchant_wallet - merchant_fee_revenue - customer_fee_revenue - order - order_principal - order_fees - merchant_payout_account subtype: type: string state: type: string enum: - none - pending - pending:debit creditSum: type: number debitSum: type: number updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt LedgerEntryEntity: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: description: The time at which the object was created. format: date-time type: string id: type: string currency: type: string enum: - mxn - usd accountingType: type: string enum: - asset - liability - revenue accountingSubtype: type: string enum: - cash - accounts_receivable - accounts_payable - interest type: type: string enum: - stripe - merchant_wallet - merchant_fee_revenue - customer_fee_revenue - order - order_principal - order_fees - merchant_payout_account subtype: type: string state: type: string enum: - none - pending - pending:debit creditSum: type: number debitSum: type: number updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: description: The time at which the object was created. format: date-time type: string id: type: string currency: type: string enum: - mxn - usd accountingType: type: string enum: - asset - liability - revenue accountingSubtype: type: string enum: - cash - accounts_receivable - accounts_payable - interest type: type: string enum: - stripe - merchant_wallet - merchant_fee_revenue - customer_fee_revenue - order - order_principal - order_fees - merchant_payout_account subtype: type: string state: type: string enum: - none - pending - pending:debit creditSum: type: number debitSum: type: number updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: {} direction: {} amount: {} amountSigned: {} accountId: {} account: {} transactionId: {} transaction: {} postedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt LedgerTransactionEntity: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: description: The time at which the object was created. format: date-time type: string id: type: string currency: type: string enum: - mxn - usd accountingType: type: string enum: - asset - liability - revenue accountingSubtype: type: string enum: - cash - accounts_receivable - accounts_payable - interest type: type: string enum: - stripe - merchant_wallet - merchant_fee_revenue - customer_fee_revenue - order - order_principal - order_fees - merchant_payout_account subtype: type: string state: type: string enum: - none - pending - pending:debit creditSum: type: number debitSum: type: number updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: {} id: {} currency: {} accountingType: {} accountingSubtype: {} type: {} subtype: {} state: {} creditSum: {} debitSum: {} updatedAt: {} requestId: {} required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt OrderAdjustmentPaymentScheduleEntry: type: object properties: date: format: date-time type: string principal: type: number customerFee: type: number required: - date - principal - customerFee OrderAdjustmentEntity: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: {} vat: {} mcc: {} ubos: {} creditReports: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: {} facebook: {} linkedin: {} instagram: {} tiktok: {} yelp: {} other: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: {} merchant: {} customerId: {} customer: {} id: {} externalId: {} batchId: {} timestamp: {} total: {} currency: {} status: {} reason: {} category: {} vendor: {} vendorName: {} items: {} additionalData: {} createdAt: {} updatedAt: {} requestId: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} currency: {} items: {} memo: {} number: {} recipientEmails: {} customerId: {} customer: {} merchantId: {} merchant: {} contactName: {} contactEmail: {} contactPhone: {} billingAddress: {} milestones: {} events: {} status: {} createdAt: {} updatedAt: {} requestId: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: {} direction: {} amount: {} amountSigned: {} accountId: {} account: {} transactionId: {} transaction: {} postedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: date: {} principal: {} customerFee: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: {} idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: amount: {} currency: {} required: - amount - currency balance: type: object properties: amount: {} currency: {} required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: |- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: date: format: date-time type: string principal: type: number customerFee: type: number required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: description: The time at which the object was created. format: date-time type: string id: type: string currency: type: string enum: - mxn - usd accountingType: type: string enum: - asset - liability - revenue accountingSubtype: type: string enum: - cash - accounts_receivable - accounts_payable - interest type: type: string enum: - stripe - merchant_wallet - merchant_fee_revenue - customer_fee_revenue - order - order_principal - order_fees - merchant_payout_account subtype: type: string state: type: string enum: - none - pending - pending:debit creditSum: type: number debitSum: type: number updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: {} direction: {} amount: {} amountSigned: {} accountId: {} account: {} transactionId: {} transaction: {} postedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt PaymentTransactionEntity: type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: |- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: |- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: amount: {} currency: {} required: - amount - currency balance: type: object properties: amount: {} currency: {} required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: {} vat: {} mcc: {} ubos: {} creditReports: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: {} facebook: {} linkedin: {} instagram: {} tiktok: {} yelp: {} other: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: {} merchant: {} customerId: {} customer: {} id: {} externalId: {} batchId: {} timestamp: {} total: {} currency: {} status: {} reason: {} category: {} vendor: {} vendorName: {} items: {} additionalData: {} createdAt: {} updatedAt: {} requestId: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} currency: {} items: {} memo: {} number: {} recipientEmails: {} customerId: {} customer: {} merchantId: {} merchant: {} contactName: {} contactEmail: {} contactPhone: {} billingAddress: {} milestones: {} events: {} status: {} createdAt: {} updatedAt: {} requestId: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: {} direction: {} amount: {} amountSigned: {} accountId: {} account: {} transactionId: {} transaction: {} postedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: date: {} principal: {} customerFee: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: {} idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: description: The time at which the object was created. format: date-time type: string id: type: string currency: type: string enum: - mxn - usd accountingType: type: string enum: - asset - liability - revenue accountingSubtype: type: string enum: - cash - accounts_receivable - accounts_payable - interest type: type: string enum: - stripe - merchant_wallet - merchant_fee_revenue - customer_fee_revenue - order - order_principal - order_fees - merchant_payout_account subtype: type: string state: type: string enum: - none - pending - pending:debit creditSum: type: number debitSum: type: number updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: {} direction: {} amount: {} amountSigned: {} accountId: {} account: {} transactionId: {} transaction: {} postedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: {} vat: {} mcc: {} ubos: {} creditReports: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: {} facebook: {} linkedin: {} instagram: {} tiktok: {} yelp: {} other: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: {} merchant: {} customerId: {} customer: {} id: {} externalId: {} batchId: {} timestamp: {} total: {} currency: {} status: {} reason: {} category: {} vendor: {} vendorName: {} items: {} additionalData: {} createdAt: {} updatedAt: {} requestId: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} currency: {} items: {} memo: {} number: {} recipientEmails: {} customerId: {} customer: {} merchantId: {} merchant: {} contactName: {} contactEmail: {} contactPhone: {} billingAddress: {} milestones: {} events: {} status: {} createdAt: {} updatedAt: {} requestId: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: {} idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: {} approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: {} currency: {} items: {} memo: {} number: {} recipientEmails: {} customerId: {} customer: {} merchantId: {} merchant: {} contactName: {} contactEmail: {} contactPhone: {} billingAddress: {} milestones: {} events: {} status: {} createdAt: {} updatedAt: {} requestId: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: {} caller: {} invoiceId: {} invoice: {} type: {} invoiceMilestoneId: {} invoiceMilestone: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: {} lastName: {} dateOfBirth: {} last4SSN: {} phone: {} email: {} address: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: {} provider: {} timestamp: {} rating: {} score: {} limit: {} balance: {} raw: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: {} message: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: {} externalId: {} externalPurchaseId: {} externalPurchase: {} sku: {} unitPrice: {} quantity: {} additionalData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} invoiceId: {} invoice: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} invoiceId: {} invoice: {} type: {} invoiceMilestoneId: {} invoiceMilestone: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: date: format: date-time type: string principal: type: number customerFee: type: number required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: description: The time at which the object was created. format: date-time type: string id: type: string currency: type: string enum: - mxn - usd accountingType: type: string enum: - asset - liability - revenue accountingSubtype: type: string enum: - cash - accounts_receivable - accounts_payable - interest type: type: string enum: - stripe - merchant_wallet - merchant_fee_revenue - customer_fee_revenue - order - order_principal - order_fees - merchant_payout_account subtype: type: string state: type: string enum: - none - pending - pending:debit creditSum: type: number debitSum: type: number updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: {} idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt OrderTermsOfferEntity: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments FileEntity: type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt OrderEventEntity: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: {} lastFour: {} bankName: {} accountName: {} bankAccountHash: {} plaidAccessToken: {} plaidAccountId: {} reauth: {} linkToken: {} plaidAssetReportId: {} plaidVerificationStatus: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: {} lastFour: {} expMonth: {} expYear: {} issuer: {} fingerprint: {} fundingType: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: {} vat: {} mcc: {} ubos: {} creditReports: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: {} facebook: {} linkedin: {} instagram: {} tiktok: {} yelp: {} other: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: {} merchant: {} customerId: {} customer: {} id: {} externalId: {} batchId: {} timestamp: {} total: {} currency: {} status: {} reason: {} category: {} vendor: {} vendorName: {} items: {} additionalData: {} createdAt: {} updatedAt: {} requestId: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} currency: {} items: {} memo: {} number: {} recipientEmails: {} customerId: {} customer: {} merchantId: {} merchant: {} contactName: {} contactEmail: {} contactPhone: {} billingAddress: {} milestones: {} events: {} status: {} createdAt: {} updatedAt: {} requestId: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: {} direction: {} amount: {} amountSigned: {} accountId: {} account: {} transactionId: {} transaction: {} postedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: date: {} principal: {} customerFee: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: {} idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt OrderEntity: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: {} required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: {} required: - amount - currency balance: type: object properties: {} required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - {} sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: type: string direction: type: string enum: - debit - credit amount: type: number minimum: 1 amountSigned: type: number accountId: type: string account: type: object properties: createdAt: {} id: {} currency: {} accountingType: {} accountingSubtype: {} type: {} subtype: {} state: {} creditSum: {} debitSum: {} updatedAt: {} requestId: {} required: - createdAt - id - currency - accountingType - accountingSubtype - type - subtype - state - creditSum - debitSum - updatedAt transactionId: type: string transaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt postedAt: format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: {} id: {} externalId: {} sku: {} orderId: {} order: {} name: {} quantity: {} unitPrice: {} price: {} url: {} imageUrl: {} metadata: {} type: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: {} name: {} category: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: {} payoutAccountId: {} payoutAccount: {} paymentMethodId: {} paymentMethod: {} merchantId: {} merchant: {} orders: {} status: {} amount: {} currency: {} scheduledAt: {} processedAt: {} instant: {} createdAt: {} updatedAt: {} requestId: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: {} provider: {} providerId: {} status: {} currency: {} amount: {} amountCaptured: {} autocapture: {} amountToCapture: {} succeededAt: {} paymentMethodId: {} paymentMethod: {} idempotencyKey: {} paymentMethodType: {} merchantId: {} merchant: {} customerId: {} customer: {} orderId: {} order: {} payoutAccountId: {} payoutAccount: {} data: {} errCode: {} errMessage: {} ledgerTransactionId: {} ledgerTransaction: {} orderAdjustmentId: {} orderAdjustment: {} createdAt: {} updatedAt: {} requestId: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: {} id: {} orderId: {} expiresAt: {} status: {} name: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} merchantFee: {} customerFee: {} total: {} schedule: {} amountPercentages: {} paymentMethods: {} payments: {} reason: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: {} originalFilename: {} contentType: {} s3Bucket: {} s3Key: {} downloadUrl: {} publicReadAccess: {} createdAt: {} updatedAt: {} requestId: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: {} id: {} dueDate: {} amount: {} invoiceId: {} invoice: {} events: {} orderId: {} order: {} createdAt: {} updatedAt: {} requestId: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: {} caller: {} orderId: {} order: {} type: {} data: {} createdAt: {} updatedAt: {} requestId: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: {} vat: {} mcc: {} ubos: {} creditReports: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: {} facebook: {} linkedin: {} instagram: {} tiktok: {} yelp: {} other: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: {} merchant: {} customerId: {} customer: {} id: {} externalId: {} batchId: {} timestamp: {} total: {} currency: {} status: {} reason: {} category: {} vendor: {} vendorName: {} items: {} additionalData: {} createdAt: {} updatedAt: {} requestId: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} currency: {} items: {} memo: {} number: {} recipientEmails: {} customerId: {} customer: {} merchantId: {} merchant: {} contactName: {} contactEmail: {} contactPhone: {} billingAddress: {} milestones: {} events: {} status: {} createdAt: {} updatedAt: {} requestId: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: date: format: date-time type: string principal: type: number customerFee: type: number required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: id: {} direction: {} amount: {} amountSigned: {} accountId: {} account: {} transactionId: {} transaction: {} postedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - {} externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: >- The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt PayoutAccountEntity: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: format: date-time type: string id: type: string operation: type: string enum: - order_finalize - order_finalize_principal - order_finalize_customer_fee - order_finalize_merchant_fee - order_adjustment_pending - order_adjustment_rejected - order_adjustment_approved - order_adjustment_principal - order_adjustment_customer_fee - order_adjustment_customer_fee_pending_forward - order_adjustment_customer_fee_pending_reverse - order_adjustment_merchant_fee - order_adjustment_merchant_fee_pending_forward - order_adjustment_merchant_fee_pending_reverse - payment_transaction_pending - payment_transaction_failed - payment_transaction_posted - payment_transaction_succeeded - payment_transaction_pending_reverse - payment_transaction_pending_forward - payment_transaction_completed entityId: type: string entries: type: array items: type: object properties: {} required: - id - direction - amount - amountSigned - accountId - account - transactionId - transaction - postedAt - createdAt - updatedAt idempotencyKey: type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: type: string status: type: string enum: - draft - pending - approved - rejected validUntil: format: date-time type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt type: type: object approvedAt: format: date-time type: string principalDelta: type: number customerFeeDelta: type: number merchantFeeDelta: type: number paymentSchedule: type: array items: type: object properties: {} required: - date - principal - customerFee approvalRequestId: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - {} type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: >- The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt MerchantEntity: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: >- The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: |- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: >- The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: >- The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: >- The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: >- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: >- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: >- The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: >- A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string externalId: description: >- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: >- The order, returned when `order` is included in the expansion parameter. allOf: - {} name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: >- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: >- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: >- The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: >- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: >- The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number merchantFee: description: >- The fee, in cents, that would be deducted from the payout. type: number customerFee: description: >- The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: {} amountPercentages: type: array items: {} paymentMethods: type: array items: {} payments: description: A list of payments for the offer. default: [] type: array items: {} reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: >- The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: >- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - {} events: description: >- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: {} orderId: description: >- The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: manuallyVerified: type: boolean lastFour: type: string bankName: type: string accountName: type: string bankAccountHash: type: string plaidAccessToken: type: string plaidAccountId: type: string reauth: type: boolean linkToken: type: string plaidAssetReportId: type: string plaidVerificationStatus: type: string required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: name: type: string lastFour: type: string expMonth: type: number expYear: type: number issuer: type: string fingerprint: type: string fundingType: type: string required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: |- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: |- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: >- The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - {} address: description: The account address. allOf: - {} email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: {} payouts: type: array items: {} deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: >- The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: {} name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: {} amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: {} initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt WriteAddressDto: type: object properties: line1: type: string city: type: string state: type: string postalCode: type: string country: type: string line2: type: string required: - line1 - city - state - postalCode - country CreateCustomerDto: type: object properties: kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency balance: type: object properties: amount: type: number currency: type: string enum: - aed - afn - all - amd - ang - aoa - ars - aud - awg - azn - bam - bbd - bdt - bgn - bhd - bif - bmd - bnd - bob - bov - brl - bsd - btn - bwp - byr - bzd - cad - cdf - che - chf - chw - clf - clp - cny - cop - cou - crc - cuc - cup - cve - czk - djf - dkk - dop - dzd - egp - ern - etb - eur - fjd - fkp - gbp - gel - ghs - gip - gmd - gnf - gtq - gyd - hkd - hnl - hrk - htg - huf - idr - ils - inr - iqd - irr - isk - jmd - jod - jpy - kes - kgs - khr - kmf - kpw - krw - kwd - kyd - kzt - lak - lbp - lkr - lrd - lsl - ltl - lvl - lyd - mad - mdl - mga - mkd - mmk - mnt - mop - mro - mur - mvr - mwk - mxn - mxv - myr - mzn - nad - ngn - nio - nok - npr - nzd - omr - pab - pen - pgk - php - pkr - pln - pyg - qar - ron - rsd - rub - rwf - sar - sbd - scr - sdg - sek - sgd - shp - sll - sos - srd - ssp - std - syp - szl - thb - tjs - tmt - tnd - top - try - ttd - twd - tzs - uah - ugx - usd - usn - uss - uyi - uyu - uzs - vef - vnd - vuv - wst - xaf - xag - xau - xba - xbb - xbc - xbd - xcd - xdr - xof - xpd - xpf - xpt - xts - xxx - yer - zar - zmw required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: >- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: >- The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: >- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: >- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: >- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: >- The Merchant Category Code (MCC) for the customer. type: string ubos: description: >- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: >- The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: >- The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: >- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: >- Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: >- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: >- The unique identifier of the item, assigned by Slope. type: string currency: description: >- The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: >- The unique invoice number that is customer facing. type: string recipientEmails: description: >- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: >- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: >- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: >- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: >- The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - {} type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: >- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: {} payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: {} payouts: type: array items: {} ach: description: Additional ACH data. nullable: true allOf: - {} card: description: Additional card data. nullable: true allOf: - {} oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: >- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: >- A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt metadata: description: A JSON object that you can attach to the customer. type: object nullable: true address: type: object properties: line1: type: string city: type: string state: type: string postalCode: type: string country: type: string line2: type: string required: - line1 - city - state - postalCode - country required: - email - phone - businessName - address CreateOrderItemDto: type: object properties: description: description: A description of the item. type: string sku: description: The SKU. type: string name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount CreateOrderDto: type: object properties: total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number currency: description: The currency. Must be one of Slope's supported currencies. type: string enum: - mxn - usd termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true customerId: description: The ID of the customer the order belongs to. type: string billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentTermsId: description: The ID of the payment terms. type: string nullable: true payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category category: description: The external purchase category. type: string invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string customer: type: object properties: kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: description: The UBO's first name. type: string lastName: description: The UBO's last name. type: string dateOfBirth: description: The UBO's date of birth (eg; `2002-07-15`) format: date-time type: string last4SSN: description: The UBO's last 4 SSN type: string phone: type: string email: type: string address: type: object properties: line1: {} line2: {} city: {} country: {} state: {} postalCode: {} required: - line1 - city - country - state - postalCode required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: type: string provider: type: string timestamp: format: date-time type: string rating: type: string score: type: number limit: type: object properties: amount: {} currency: {} required: - amount - currency balance: type: object properties: amount: {} currency: {} required: - amount - currency raw: type: object required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: {} id: {} merchantId: {} merchant: {} merchantFeePercentage: {} customerFeePercentage: {} customerFeeFlat: {} processingFeePercentage: {} paymentMethods: {} name: {} schedule: {} amountPercentages: {} initialAttemptDelay: {} maxAttempts: {} attemptBackoffCoefficient: {} maxAttemptDelay: {} gracePeriod: {} merchantProcessingFee: {} hidden: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: >- Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: >- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: >- The unique identifier of the customer, assigned by Slope. type: string merchantId: description: >- The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: >- The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: >- The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: description: >- A short string describing why the external purchase has its given status. type: string message: description: >- A human-friendly message explaining why the external purchase has its given status. type: string category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: description: >- A unique identifier of the external purchase item, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase item, assigned by you. The value must be unique across all items within a single external purchase object. type: string nullable: true externalPurchaseId: description: >- The ID of the external purchase this item belongs to. type: string externalPurchase: description: >- The external purchase this item belongs to, returned when `externalPurchase` is included in the expansion parameter. allOf: - type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt sku: description: The SKU. type: string unitPrice: description: The unit price. type: number nullable: true quantity: description: The quantity of the item. type: number additionalData: description: >- Additional data describing the item. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt metadata: description: A JSON object that you can attach to the customer. type: object nullable: true address: type: object properties: line1: type: string city: type: string state: type: string postalCode: type: string country: type: string line2: type: string required: - line1 - city - state - postalCode - country required: - email - phone - businessName - address items: type: array items: type: object properties: description: description: A description of the item. type: string sku: description: The SKU. type: string name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount required: - total - currency PageMetaDto: type: object properties: total: type: number beforeCursor: type: string afterCursor: type: string required: - total PageDto: type: object properties: data: type: array items: type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. metadata: type: object properties: total: type: number beforeCursor: type: string afterCursor: type: string required: - total required: - data - metadata Condition: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: type: object properties: attribute: type: string operator: type: string value: type: object conditions: type: array items: {} required: - operator required: - operator required: - operator required: - operator UpdateOrderDto: type: object properties: forceUnderwriting: type: boolean SubmitOrderDTO: type: object properties: termsAcceptedAt: format: date-time type: string termsUrl: type: string OpenOrderDTO: type: object properties: externalId: type: string termsAcceptedAt: format: date-time type: string termsUrl: type: string CreatePayoutAccountDto: type: object properties: name: type: string paymentMethodType: type: string enum: - ach - wire businessName: type: string email: type: string address: type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode routingNumber: type: string accountNumber: type: string isDefaultAccount: type: boolean taxId: type: string accountType: type: object externalId: description: The External ID of the payout / vendor account. type: string required: - name - paymentMethodType - businessName - email - address - routingNumber - accountNumber - isDefaultAccount - taxId - accountType UpdatePayoutAccountDto: type: object properties: email: type: string name: type: string isDefaultAccount: type: boolean required: - email - name - isDefaultAccount CreateInvoiceMilestoneDto: type: object properties: dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number required: - dueDate - amount CreateInvoiceItemDto: type: object properties: description: description: A description of the item. type: string sku: description: The SKU. type: string name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount CreateInvoiceDto: type: object properties: customerId: description: The ID of the customer the order belongs to. type: string currency: description: The currency. Must be one of Slope's supported currencies. type: string enum: - mxn - usd milestones: type: array items: type: object properties: dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number required: - dueDate - amount items: type: array items: type: object properties: description: description: A description of the item. type: string sku: description: The SKU. type: string name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount memo: description: A memo field that will be displayed to the receiver of the invoice type: string contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string status: type: string enum: - draft - open - paid - canceled - void required: - customerId - currency - milestones - items - status UpdateCustomerDto: type: object properties: {} ErrorEntity: type: object properties: statusCode: description: >- The standard HTTP status code describing the error, usually used programmatically. type: number code: description: A short string describing the error, usually used programmatically. type: string message: description: A human-friendly message explaining the error. type: string required: - statusCode - code - message OrdersCreateNewOrderRequest: type: object properties: total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number currency: description: The currency. Must be one of Slope's supported currencies. type: string enum: - mxn - usd termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true customerId: description: The ID of the customer the order belongs to. type: string billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentTermsId: description: The ID of the payment terms. type: string nullable: true payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category category: description: The external purchase category. type: string invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string customer: type: object properties: kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: {} creditReports: type: array items: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - {} id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: {} additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt metadata: description: A JSON object that you can attach to the customer. type: object nullable: true address: type: object properties: line1: type: string city: type: string state: type: string postalCode: type: string country: type: string line2: type: string required: - line1 - city - state - postalCode - country required: - email - phone - businessName - address items: type: array items: type: object properties: description: description: A description of the item. type: string sku: description: The SKU. type: string name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount required: - total - currency OrdersUpdateAttributesRequest: type: object properties: forceUnderwriting: type: boolean OrdersSubmitOrderStatusRequest: type: object properties: termsAcceptedAt: format: date-time type: string termsUrl: type: string OrdersOpenOrderRequest: type: object properties: externalId: type: string termsAcceptedAt: format: date-time type: string termsUrl: type: string OrdersRefundOrderRequest: type: object properties: amount: description: >- The amount, in cents, to refund to the customer. For a full refund, this should match the order total. For a partial refund, this should be less than the order total. type: number nullable: true payoutAccountId: description: |- The payout account ID to debit the refund from. If none is provided, the original payout account will be used. type: string required: - amount PayoutAccountsCreateWithExternalIdRequest: type: object properties: name: type: string paymentMethodType: type: string enum: - ach - wire businessName: type: string email: type: string address: type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode routingNumber: type: string accountNumber: type: string isDefaultAccount: type: boolean taxId: type: string accountType: type: object externalId: description: The External ID of the payout / vendor account. type: string required: - name - paymentMethodType - businessName - email - address - routingNumber - accountNumber - isDefaultAccount - taxId - accountType PayoutAccountsUpdateWithExternalIdRequest: type: object properties: email: type: string name: type: string isDefaultAccount: type: boolean required: - email - name - isDefaultAccount InvoicesCreateNewInvoiceRequest: type: object properties: customerId: description: The ID of the customer the order belongs to. type: string currency: description: The currency. Must be one of Slope's supported currencies. type: string enum: - mxn - usd milestones: type: array items: type: object properties: dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number required: - dueDate - amount items: type: array items: type: object properties: description: description: A description of the item. type: string sku: description: The SKU. type: string name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount memo: description: A memo field that will be displayed to the receiver of the invoice type: string contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string status: type: string enum: - draft - open - paid - canceled - void required: - customerId - currency - milestones - items - status CustomersRegisterNewCustomerRequest: type: object properties: kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: firstName: {} lastName: {} dateOfBirth: {} last4SSN: {} phone: {} email: {} address: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: description: {} provider: {} timestamp: {} rating: {} score: {} limit: {} balance: {} raw: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: code: {} message: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: id: {} externalId: {} externalPurchaseId: {} externalPurchase: {} sku: {} unitPrice: {} quantity: {} additionalData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt metadata: description: A JSON object that you can attach to the customer. type: object nullable: true address: type: object properties: line1: type: string city: type: string state: type: string postalCode: type: string country: type: string line2: type: string required: - line1 - city - state - postalCode - country required: - email - phone - businessName - address CustomersUpdateExistingCustomerRequest: type: object properties: {} MerchantsGetSettingsResponse: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: |- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: |- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: |- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt OrdersListOrdersResponse: allOf: - type: object properties: data: type: array items: type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. metadata: type: object properties: total: type: number beforeCursor: type: string afterCursor: type: string required: - total required: - data - metadata - properties: data: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: >- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: >- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: >- The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersCreateNewOrderResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersGetByIdResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersUpdateAttributesResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersSubmitOrderStatusResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersOpenOrderResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersFinalizeOrderResponse: type: object properties: {} example: {} OrdersCancelOrderResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersRefundOrderResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt OrdersResetOrderResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: |- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: description: description: A description of the payment terms. type: string nullable: true id: description: The unique identifier assigned by Slope. type: string merchantId: description: The ID of the merchant the payment terms belong to. type: string merchant: description: |- The merchant the payment terms belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number processingFeePercentage: description: >- The fee percentage, out of 100, allocated for processing fees. type: number paymentMethods: description: >- The payment method types that are allowed for the payment terms. type: array items: type: string enum: - ach - card - oxxo - spei - wire name: description: The name of the payment terms. type: string schedule: description: >- An array of [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) strings to be used to generate the payment schedule relative to the start date. Each element in the array describes a payment such that the first element describes when the first payment would be due. type: array items: type: string amountPercentages: description: |- An array of percentages, out of 100, to be used to generate the payment amounts relative to the an order's total with fees. Each element in the array describes a payment such that the first element describes the amount of the first payment. type: array items: type: number initialAttemptDelay: type: string maxAttempts: type: number attemptBackoffCoefficient: type: number maxAttemptDelay: type: string gracePeriod: type: string merchantProcessingFee: type: boolean hidden: description: |- If true, hides the payment terms object from API responses an the widget. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: |- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: id: type: string name: type: string category: type: string required: - id - name - category payments: description: |- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: |- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: id: type: string provider: type: string enum: - stripe - stripe_connect - brex - modern_treasury providerId: type: string status: type: string enum: - scheduled_execution - awaiting_action - pending - authorized - scheduled_cancelation - scheduled_capture - succeeded - failed - canceled currency: type: string enum: - mxn - usd amount: type: number amountCaptured: type: number autocapture: type: boolean amountToCapture: type: number succeededAt: format: date-time type: string paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt idempotencyKey: type: string paymentMethodType: type: string enum: - ach - card - oxxo - spei - wire merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: type: string customer: type: object properties: ineligibilityReason: {} ineligibilityReasons: {} kyb: {} socialMediaUrls: {} acquisitionDate: {} merchant: {} id: {} merchantId: {} email: {} phone: {} eligible: {} businessName: {} externalId: {} address: {} metadata: {} externalPurchases: {} backupPaymentMethodId: {} backupPaymentMethod: {} orders: {} invoices: {} paymentMethods: {} isGuest: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt data: type: object errCode: type: string errMessage: type: string ledgerTransactionId: type: string ledgerTransaction: type: object properties: postedAt: {} id: {} operation: {} entityId: {} entries: {} idempotencyKey: {} createdAt: {} updatedAt: {} requestId: {} required: - postedAt - id - operation - entityId - entries - idempotencyKey - createdAt - updatedAt orderAdjustmentId: type: string orderAdjustment: type: object properties: id: {} status: {} validUntil: {} orderId: {} order: {} customerId: {} customer: {} merchantId: {} merchant: {} type: {} approvedAt: {} principalDelta: {} customerFeeDelta: {} merchantFeeDelta: {} paymentSchedule: {} approvalRequestId: {} ledgerTransactionId: {} ledgerTransaction: {} createdAt: {} updatedAt: {} requestId: {} required: - id - status - validUntil - orderId - order - customerId - customer - merchantId - merchant - type - approvedAt - principalDelta - customerFeeDelta - merchantFeeDelta - paymentSchedule - approvalRequestId - ledgerTransactionId - ledgerTransaction - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: description: description: The offer description type: string id: description: The unique identifier assigned by Slope. type: string orderId: description: The ID of the order the offer belongs to. type: string expiresAt: description: The time at which the offer will expire. format: date-time type: string status: description: The offer status, one of `approved` or `rejected`. type: string enum: - approved - rejected name: description: The name of the offer (eg; `net7`). type: string merchantFeePercentage: description: >- The fee percentage, out of 100, that would be deducted from the payout. type: number customerFeePercentage: description: >- The fee percentage, out of 100, that would be added to the total. type: number customerFeeFlat: description: The flat fee, in cents, that would be added to the total. type: number merchantFee: description: The fee, in cents, that would be deducted from the payout. type: number customerFee: description: The fee, in cents, that would be deducted from the payout. type: number total: description: The total amount, in cents, including fees. type: number schedule: type: array items: type: string amountPercentages: type: array items: type: number paymentMethods: type: array items: type: string enum: - ach - card - oxxo - spei - wire payments: description: A list of payments for the offer. default: [] type: array items: type: object reason: description: The reason the offer was rejected. type: object required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: id: type: string originalFilename: type: string contentType: type: string s3Bucket: type: string s3Key: type: string downloadUrl: type: string nullable: true publicReadAccess: type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: |- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: description: description: >- Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: >- The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: id: type: string caller: type: string orderId: type: string order: type: object properties: id: {} number: {} externalId: {} merchantId: {} merchant: {} customerId: {} customer: {} status: {} paymentStatus: {} merchantStatus: {} billingAddress: {} metadata: {} additionalData: {} paymentMethodId: {} paymentMethodIdFinalized: {} paymentMethod: {} paymentTermsId: {} paymentTerms: {} paymentTermsStartAt: {} termsAcceptedAt: {} termsUrl: {} total: {} totalFinalized: {} merchantFee: {} merchantFeeFinalized: {} customerFee: {} customerFeeFinalized: {} totalWithFees: {} amountOutstanding: {} amountPaid: {} amountPending: {} amountOverdue: {} amountRefundedFee: {} amountRefundedPrincipal: {} contactName: {} contactEmail: {} contactPhone: {} currency: {} openedAt: {} finalizedAt: {} finalizeBy: {} items: {} invoiceInvokedAt: {} invoiceDueDate: {} category: {} vendor: {} payments: {} payoutAccountId: {} payoutAccount: {} payoutPaymentMethodId: {} payoutPaymentMethod: {} payoutId: {} payout: {} payoutPaymentTransactionId: {} payoutPaymentTransaction: {} offeredTerms: {} reason: {} promissoryNoteFile: {} promissoryNoteFileId: {} isGuest: {} invoiceMilestoneId: {} invoiceMilestone: {} events: {} createdAt: {} updatedAt: {} requestId: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt type: type: string enum: - approved - rejected - customer_agreement_accepted - opened - finalized data: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt PayoutAccountsListAllPayoutAccountsResponse: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - {} childMerchants: type: array items: {} isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - {} defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - {} merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: {} widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: >- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - {} metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - {} paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: >- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: >- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: {} invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - {} payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - {} payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - {} payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - {} offeredTerms: description: A list offered payment terms for the order. type: array items: {} reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - {} promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - {} events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: {} createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - {} orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: {} status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt PayoutAccountsCreateWithExternalIdResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt PayoutAccountsGetByIdResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt PayoutAccountsUpdateWithExternalIdResponse: type: object properties: id: description: The unique identifier, assigned by Slope. type: string name: description: Bank account nickname type: string merchantId: description: The ID of the merchant the payout belongs to. type: string externalId: description: The External ID of the payout / vendor account. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt address: description: The account address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode email: description: The email address of the merchant / vendor. type: string businessName: description: The business name of the merchant / vendor. type: string paymentMethodType: enum: - ach - wire type: string currency: description: The currency this payout account supports. enum: - mxn - usd type: string orders: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string payoutAccountId: type: string payoutAccount: type: object properties: id: {} name: {} merchantId: {} externalId: {} merchant: {} address: {} email: {} businessName: {} paymentMethodType: {} currency: {} orders: {} payouts: {} deletedAt: {} createdAt: {} updatedAt: {} requestId: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt paymentMethodId: type: string paymentMethod: type: object properties: id: {} legacyPayoutAccountId: {} customerId: {} customer: {} type: {} orders: {} payoutOrders: {} payouts: {} ach: {} card: {} oxxo: {} spei: {} plaidDisconnectedAt: {} isGuest: {} deletedAt: {} data: {} providerData: {} createdAt: {} updatedAt: {} requestId: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantId: description: The ID of the merchant the payout belongs to. type: string merchant: description: The merchant the payout belongs to. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt orders: description: |- The order the payout belongs to, returned when `order` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt status: description: |- The status of the payout, one of: - `scheduled` - `pending` - `paid` - `failed` type: string enum: - scheduled - pending - paid - failed - canceled amount: description: The payout amount. type: number currency: description: The currency, one of Slope's supported currencies. type: string enum: - mxn - usd scheduledAt: description: The time at which the payout was scheduled. format: date-time type: string nullable: true processedAt: description: The time at which the payout was processed. format: date-time type: string nullable: true instant: description: |- Whether the payout was triggered instantly by a single order. type: boolean createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt InvoicesListResponse: allOf: - type: object properties: data: type: array items: type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. metadata: type: object properties: total: type: number beforeCursor: type: string afterCursor: type: string required: - total required: - data - metadata - properties: data: type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: >- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: {} memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: {} customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - {} merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - {} contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - {} milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: {} events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: {} status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt InvoicesCreateNewInvoiceResponse: type: object properties: {} example: {} InvoicesGetByIdResponse: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: |- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt InvoicesOpenDraftResponse: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: |- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt InvoicesVoidInvoiceResponse: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: |- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt InvoicesCancelInvoiceResponse: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: description: description: A description of the item. type: string id: description: The unique identifier of the item, assigned by Slope. type: string invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: The invoice, the item belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt externalId: description: |- A unique identifier for the item, assigned by you. The value must be unique across all items within a single order. type: string nullable: true sku: description: The SKU. type: string orderId: description: The ID of the order the item belongs to. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt name: description: The name of the item. type: string quantity: description: The quantity. type: number unitPrice: description: |- The unit price. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number price: description: >- The total for the item. Value must be entered in cents as an integer. For example, 765, not $7.65. type: number url: description: The item URL type: string nullable: true imageUrl: description: The item image URL type: string nullable: true metadata: description: >- A JSON object of additional attribute that you can attach to the item. type: object nullable: true type: description: >- Type of the order item, either LineItem or Discount, which signifies whether or not it should add or subtract from the total. type: string enum: - lineItem - discount createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: ineligibilityReason: type: object properties: code: {} message: {} context: {} internal_message: {} missingFields: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: {} required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: {} socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: {} required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode milestones: description: |- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: description: description: Description of the invoice milestone, noted for the customer. type: string id: description: The unique identifier of the item, assigned by Slope. type: string dueDate: description: >- The due date of the milestone. Due date should be marked as beginnign of day, and ignore any time components. format: date-time type: string amount: description: The invoice milestone amount, entered in cents as an integer. type: number invoiceId: description: The ID of the invoice the item belongs to. type: string invoice: description: |- The invoice, returned when `invoice` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt events: description: |- The invoice, returned when `invoice` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt orderId: description: The ID of the order corresponding to the invoice milestone. type: string order: description: |- The order, returned when `order` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string caller: type: string invoiceId: description: The ID of the invoice the event belongs to. type: string invoice: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt type: description: >- Type of the invoice event signifying what type of event occurred. type: string enum: - invoice_opened - invoice_voided - invoice_canceled - email_sent invoiceMilestoneId: description: The ID of the invoice milestone the event belongs to. type: string invoiceMilestone: description: The invoice the event belongs to. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt CustomersListAllResponse: allOf: - type: object properties: data: type: array items: type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. metadata: type: object properties: total: type: number beforeCursor: type: string afterCursor: type: string required: - total required: - data - metadata - properties: data: type: array items: type: object properties: ineligibilityReason: type: object properties: {} required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: {} kyb: description: Additional Know Your Business (KYB) data. allOf: - {} socialMediaUrls: description: The customer's social media URLs. allOf: - {} acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - {} id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: >- The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - {} metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: {} backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - {} orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: {} invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: {} paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: {} isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt CustomersRegisterNewCustomerResponse: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt CustomersGetByIdResponse: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt CustomersUpdateExistingCustomerResponse: type: object properties: ineligibilityReason: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message ineligibilityReasons: description: Reasons for ineligibility if a customer is ineligible. type: array items: type: object properties: code: description: >- A short string describing why the customer is ineligible, usually used programmatically. type: string message: description: >- A human-friendly message explaining why the customer is ineligible. type: string context: type: object internal_message: type: string missingFields: description: >- A list of attributes the customer is missing that are affecting the customer's eligibility. type: array items: type: string required: - code - message kyb: description: Additional Know Your Business (KYB) data. allOf: - type: object properties: taxId: description: |- The customer's business tax ID, as given by the customer's country. Use EIN for customers in the United States and RFC for customers in Mexico. type: string vat: description: The VAT number of the company. type: string mcc: description: The Merchant Category Code (MCC) for the customer. type: string ubos: description: |- A list of Ultimate Beneficial Owners (UBOs). UBOs are the individuals that ultimately benefit when the customer makes a transaction. type: array items: type: object properties: {} required: - firstName - lastName - dateOfBirth - last4SSN - phone - email - address creditReports: type: array items: type: object properties: {} required: - provider - timestamp - rating - score - description - limit - balance - raw socialMediaUrls: description: The customer's social media URLs. allOf: - type: object properties: twitter: description: The customer's Twitter URL. type: string facebook: description: The customer's Facebook URL. type: string linkedin: description: The customer's LinkedIn URL. type: string instagram: description: The customer's Instagram URL. type: string tiktok: description: The customer's TikTok URL. type: string yelp: description: The customer's Yelp URL. type: string other: description: |- Other social media URLS belonging to the customer. type: array items: type: string acquisitionDate: description: >- The date and time at which you onboarded the customer (ie; their first order), in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string nullable: true merchant: description: |- The merchant that which the customer belongs, returned when included in the `expand` parameter. allOf: - type: object properties: id: description: The unique identifier assigned by Slope. type: string merchantId: description: The unique identifier assigned by Slope. type: string parentMerchantId: description: The parent merchantId, if this is a sub-merchant. type: string parentMerchant: nullable: true allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt childMerchants: type: array items: type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt isParent: type: boolean email: description: >- The email address. Primarily used for communications and support. type: string businessName: description: The business name. type: string defaultCurrency: description: >- The default currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string defaultPayoutAccountId: type: string nullable: true defaultPayoutAccount: nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt defaultPaymentMethodId: type: string nullable: true defaultPaymentMethod: nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt merchantBalanceLimit: description: The merchant's balance limit, in cents. type: number customerBalanceLimit: description: The customer balance limit, in cents. type: number overdueGracePeriodMs: description: >- The number of milliseconds to wait before considering a payment as overdue. This may be overridden by the payment terms object. A value of -1 indicates that no offer will be rejected because of overdue payments. type: number orderTotalMin: description: The minimum accepted order total, in cents. type: number orderTotalMax: description: The maximum accepted order total, in cents. type: number instantPayouts: type: boolean payoutSchedule: type: array items: type: number maximum: 6 minimum: 0 widgetSessionTimeoutMs: type: number paymentTerms: description: >- A list of payment terms belonging to the merchant, returned if `paymentTerms` is included in the expansion property. type: array items: type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt id: description: The unique identifier of the customer, assigned by Slope. type: string merchantId: description: The ID of the merchant that which the customer belongs. type: string email: description: The customer's email address. Primarily used for communications. type: string nullable: true phone: description: >- The customer's phone number. Phone numbers are stored in E.164 format to support international telephone numbers: https://www.twilio.com/docs/glossary/what-e164. The `+` is purposely included. Primarily used for communications. type: string eligible: description: >- Whether or not the customer is eligible for Buy Now, Pay Later offers. If `false`, they are highly unlikely to receive any approved offers for orders created on their behalf. type: boolean businessName: description: The customer's business name. type: string nullable: true externalId: description: The unique identifier of the customer, assigned by you. type: string nullable: true address: description: The customer's business address. allOf: - type: object properties: line1: type: string line2: type: string city: type: string country: type: string state: type: string postalCode: type: string required: - line1 - city - country - state - postalCode metadata: description: A JSON object that you can attach to the customer. type: object nullable: true externalPurchases: description: The customer's external purchases. type: array items: type: object properties: merchantId: type: string merchant: type: object properties: id: {} merchantId: {} parentMerchantId: {} parentMerchant: {} childMerchants: {} isParent: {} email: {} businessName: {} defaultCurrency: {} defaultPayoutAccountId: {} defaultPayoutAccount: {} defaultPaymentMethodId: {} defaultPaymentMethod: {} merchantBalanceLimit: {} customerBalanceLimit: {} overdueGracePeriodMs: {} orderTotalMin: {} orderTotalMax: {} instantPayouts: {} payoutSchedule: {} widgetSessionTimeoutMs: {} paymentTerms: {} createdAt: {} updatedAt: {} requestId: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: >- The ID of the customer that which the external purchase belongs. type: string customer: description: >- The customer that which the external purchase belongs, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt id: description: >- The unique identifier of the external purchase, assigned by Slope. type: string externalId: description: >- A unique identifier for the external purchase, assigned by you. The value must be unique across all external purchases within your Slope account. type: string batchId: description: >- The ID of the batch request this external purchase was a part of. This value could is mutable and can be overwritten with a new ID or null value. Underwriting service primarily uses this value to avoid duplicate evaluation runs when a batch write is committed. type: string timestamp: description: |- The time at which the external purchase was made, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. format: date-time type: string total: description: The total order amount, in cents. type: number currency: description: The currency. Must be a supported currency. type: string status: description: >- The external purchase status. One of `open`, `paid`, `overdue`, `defaulted`, or `canceled`. type: string enum: - open - paid - overdue - defaulted - canceled reason: description: >- The reason for an order given status, usually set when an order status is `overdue`, `defaulted`, or `canceled`. allOf: - type: object properties: {} category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. type: string vendorName: description: The vendor name, if not you. type: string items: description: A list of items included in the external purchase. type: array items: type: object properties: {} required: - id - externalId - externalPurchaseId - externalPurchase - sku - unitPrice - quantity - additionalData - createdAt - updatedAt additionalData: description: >- Additional data describing the external purchase. The attributes expected in this object will vary depending on your integration. type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - merchantId - merchant - customerId - customer - id - externalId - batchId - timestamp - total - currency - status - reason - category - vendor - vendorName - items - additionalData - createdAt - updatedAt backupPaymentMethodId: description: The ID of the backup payment method used for collections type: string backupPaymentMethod: description: The backup payment method used for collections allOf: - type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: >- A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt orders: description: |- The customer's orders, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string number: description: The unique order number that is customer facing. type: string externalId: description: |- The unique identifier of the order, assigned by you. The value must be unique across all orders within your Slope account. type: string merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt status: description: >- The current status of an order, once an order is finalized, it can't change enum: - pending - approved - rejected - submitted - opening - open - finalizing - finalized - unpaid - partiallyPaid - complete - defaulted - canceled - refunded type: string paymentStatus: description: The order's current payment_status for buyers enum: - unpaid - partiallyPaid - paid - completed - refunded - opening - open - canceled type: string merchantStatus: description: >- The order's current payment_status for merchant's search & display type: object billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode metadata: description: >- A JSON object of additional attribute that you can attach to the order. This value will not be used for risk assessment. type: object nullable: true additionalData: description: >- Additional data describing the order. The attributes expected in this object will vary depending on your integration and may be used for risk assessment. type: object paymentMethodId: description: >- The ID of the payment method that will be used to pay the order. type: string nullable: true paymentMethodIdFinalized: type: string nullable: true paymentMethod: description: |- The payment method, returned when `paymentMethod` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt paymentTermsId: description: The ID of the payment terms. type: string nullable: true paymentTerms: description: |- The payment terms, returned when `paymentTerms` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - merchantId - merchant - merchantFeePercentage - customerFeePercentage - customerFeeFlat - processingFeePercentage - paymentMethods - name - description - schedule - amountPercentages - initialAttemptDelay - maxAttempts - attemptBackoffCoefficient - maxAttemptDelay - gracePeriod - merchantProcessingFee - hidden - createdAt - updatedAt paymentTermsStartAt: description: >- The time at which to start the payment terms. This when a payout is triggered and the payment term duration begins. format: date-time type: string nullable: true termsAcceptedAt: description: |- The timestamp the customer accepted Slope's terms and conditions for the selected offer. format: date-time type: string nullable: true termsUrl: description: |- The URL of the terms and conditions document that the customer accepted. type: string nullable: true total: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number totalFinalized: description: |- The order total, entered in cents as an integer. E.g., 765, not $7.65. type: number merchantFee: description: The fee, in cents, deducted from your payout. type: number merchantFeeFinalized: type: number customerFee: description: |- The fee, in cents, added to the total and paid by the customer. type: number customerFeeFinalized: type: number totalWithFees: description: The total amount including the customer fee. type: number amountOutstanding: type: number amountPaid: type: number amountPending: type: number amountOverdue: type: number amountRefundedFee: type: number amountRefundedPrincipal: type: number contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string openedAt: description: The time at which the order was opened. format: date-time type: string nullable: true finalizedAt: description: The time at which the order was finalized. format: date-time type: string nullable: true finalizeBy: description: |- The time at which the order must be finalized by to avoid cancellation. format: date-time type: string nullable: true items: description: |- A list of items included in the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt invoiceInvokedAt: description: The date an invoice was sent to the customer format: date-time type: string nullable: true invoiceDueDate: description: The date an invoice should be marked as due format: date-time type: string nullable: true category: description: The external purchase category. type: string vendor: description: The vendor identifier, if not you. allOf: - type: object properties: {} required: - id - name - category payments: description: >- A list of payments relating to the order, returned if `payments` is included in the expansion parameter. type: array items: type: object properties: {} payoutAccountId: description: >- The ID of the payout account that funds will be paid out to on finalization. type: string nullable: true payoutAccount: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - name - merchantId - externalId - merchant - address - email - businessName - paymentMethodType - currency - orders - payouts - deletedAt - createdAt - updatedAt payoutPaymentMethodId: description: >- The ID of the payout account that funds will be paid out to on finalization. . type: string nullable: true payoutPaymentMethod: description: >- The payout account that funds will be paid out to on finalization. nullable: true allOf: - type: object properties: {} required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt payoutId: description: 'The ID of the payout. TODO: deprecate' type: string nullable: true payout: description: >- The payout of the order total, less the merchant fee. This object is only returned if `payout` is included in the expansion parameter. nullable: true allOf: - type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt payoutPaymentTransactionId: description: The ID of the payment transaction payout type: string nullable: true payoutPaymentTransaction: description: The payment transaction payout of the order nullable: true allOf: - type: object properties: {} required: - id - provider - providerId - status - currency - amount - amountCaptured - autocapture - amountToCapture - succeededAt - paymentMethodId - paymentMethod - idempotencyKey - paymentMethodType - merchantId - merchant - customerId - customer - orderId - order - payoutAccountId - payoutAccount - data - errCode - errMessage - ledgerTransactionId - ledgerTransaction - orderAdjustmentId - orderAdjustment - createdAt - updatedAt offeredTerms: description: A list offered payment terms for the order. type: array items: type: object properties: {} required: - id - orderId - expiresAt - status - name - description - merchantFeePercentage - customerFeePercentage - customerFeeFlat - merchantFee - customerFee - total - schedule - amountPercentages - paymentMethods - payments reason: description: Reason describes the status, usually set for sad paths. type: object promissoryNoteFile: description: The file containing the PDF terms and conditions allOf: - type: object properties: {} required: - id - originalFilename - contentType - s3Bucket - s3Key - downloadUrl - publicReadAccess - createdAt - updatedAt promissoryNoteFileId: type: string isGuest: type: boolean invoiceMilestoneId: description: The ID of the invoice milestone corresponding to the order. type: string invoiceMilestone: description: >- The invoice milestone, returned when `invoiceMilestone` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of product events that have occurred for the order, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - orderId - order - type - createdAt - updatedAt createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt invoices: description: |- The customer's invoices, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier of the item, assigned by Slope. type: string currency: description: The currency. Must be one of Slope's supported currencies. enum: - mxn - usd type: string items: description: |- A list of items and discounts included in the invoice, returned if `items` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - invoiceId - invoice - externalId - name - quantity - unitPrice - price - url - imageUrl - metadata - type - createdAt - updatedAt memo: description: >- A memo field that will be displayed to the receiver of the invoice type: string number: description: The unique invoice number that is customer facing. type: string recipientEmails: description: |- A list of email recipients that should also receive comms when a customer receives a comm. type: array items: type: string customerId: description: The ID of the customer the order belongs to. type: string customer: description: |- The customer the order belongs to, returned when `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt merchantId: description: The ID of the merchant the order belongs to. type: string merchant: description: |- The merchant the order belongs to, returned when `merchant` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - parentMerchantId - parentMerchant - childMerchants - isParent - email - businessName - defaultCurrency - defaultPayoutAccountId - defaultPayoutAccount - defaultPaymentMethodId - defaultPaymentMethod - merchantBalanceLimit - customerBalanceLimit - overdueGracePeriodMs - orderTotalMin - orderTotalMax - instantPayouts - payoutSchedule - widgetSessionTimeoutMs - paymentTerms - createdAt - updatedAt contactName: type: string nullable: true contactEmail: type: string nullable: true contactPhone: type: string nullable: true billingAddress: description: The billing address. allOf: - type: object properties: {} required: - line1 - city - country - state - postalCode milestones: description: >- A list of milestones for the invoice. returned if `milestones` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - dueDate - amount - invoiceId - invoice - events - orderId - order - createdAt - updatedAt events: description: |- A list of events that have occurred for the invoice, returned if `events` is included in the expansion. type: array items: type: object properties: {} required: - id - caller - invoiceId - invoice - type - createdAt - updatedAt status: description: Status of the invoice enum: - draft - open - paid - canceled - void type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - currency - items - memo - number - recipientEmails - customerId - customer - merchantId - merchant - contactName - contactEmail - contactPhone - billingAddress - milestones - events - status - createdAt - updatedAt paymentMethods: description: |- The customer's payment methods, returned when included in the `expand` parameter. type: array items: type: object properties: id: description: The unique identifier, assigned by Slope. type: string legacyPayoutAccountId: description: >- The legacy ID of the payout account the payment method belongs to. type: string customerId: description: The ID of the customer the payment method belongs to. type: string customer: description: >- The customer the payment method belongs to, returned when included `customer` is included in the expansion parameter. allOf: - type: object properties: {} required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt type: description: |- The type of payment method, one of: - `card` - `oxxo` - `spei` - `ach` type: string enum: - ach - card - oxxo - spei - wire orders: description: |- A list of orders that use the payment method, returned when `orders` is included in the expansion parameter. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payoutOrders: description: A list of orders that use this as their payout payment method. type: array items: type: object properties: {} required: - id - number - externalId - merchantId - merchant - customerId - customer - status - paymentStatus - merchantStatus - billingAddress - metadata - additionalData - paymentMethodId - paymentMethodIdFinalized - paymentMethod - paymentTermsId - paymentTerms - paymentTermsStartAt - termsAcceptedAt - termsUrl - total - totalFinalized - merchantFee - merchantFeeFinalized - customerFee - customerFeeFinalized - totalWithFees - amountOutstanding - amountPaid - amountPending - amountOverdue - amountRefundedFee - amountRefundedPrincipal - contactName - contactEmail - contactPhone - currency - openedAt - finalizedAt - finalizeBy - items - invoiceInvokedAt - invoiceDueDate - category - vendor - payments - payoutAccountId - payoutAccount - payoutPaymentMethodId - payoutPaymentMethod - payoutId - payout - payoutPaymentTransactionId - payoutPaymentTransaction - offeredTerms - reason - promissoryNoteFile - promissoryNoteFileId - isGuest - invoiceMilestone - events - createdAt - updatedAt payouts: type: array items: type: object properties: {} required: - id - payoutAccountId - payoutAccount - paymentMethodId - paymentMethod - merchantId - merchant - orders - status - amount - currency - scheduledAt - processedAt - instant - createdAt - updatedAt ach: description: Additional ACH data. nullable: true allOf: - type: object properties: {} required: - lastFour - bankName - accountName - bankAccountHash card: description: Additional card data. nullable: true allOf: - type: object properties: {} required: - name - lastFour - expMonth - expYear - issuer - fingerprint - fundingType oxxo: description: Additional OXXO data. type: object nullable: true spei: description: Additional OXXO data. type: object nullable: true plaidDisconnectedAt: description: The date plaid account got disconnected format: date-time type: string isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string data: type: object providerData: type: object createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - legacyPayoutAccountId - customerId - customer - type - orders - payoutOrders - payouts - ach - card - oxxo - spei - plaidDisconnectedAt - isGuest - deletedAt - data - providerData - createdAt - updatedAt isGuest: type: boolean deletedAt: description: The time at which this object was soft deleted. format: date-time type: string createdAt: description: The time at which the object was created. format: date-time type: string updatedAt: description: The time at which the object was last updated. format: date-time type: string requestId: type: string required: - id - merchantId - email - phone - eligible - businessName - externalId - address - metadata - externalPurchases - backupPaymentMethodId - backupPaymentMethod - orders - invoices - paymentMethods - isGuest - deletedAt - createdAt - updatedAt x-readme: explorer-enabled: true proxy-enabled: true samples-enabled: true _id: 64b70cb8dceef3000ab8f4ac